home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sgbequ.z / sgbequ
Encoding:
Text File  |  2002-10-03  |  4.6 KB  |  133 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGBBBBEEEEQQQQUUUU((((3333SSSS))))                                                          SSSSGGGGBBBBEEEEQQQQUUUU((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGBEQU - compute row and column scalings intended to equilibrate an M-
  10.      by-N band matrix A and reduce its condition number
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SGBEQU( M, N, KL, KU, AB, LDAB, R, C, ROWCND, COLCND, AMAX,
  14.                         INFO )
  15.  
  16.          INTEGER        INFO, KL, KU, LDAB, M, N
  17.  
  18.          REAL           AMAX, COLCND, ROWCND
  19.  
  20.          REAL           AB( LDAB, * ), C( * ), R( * )
  21.  
  22. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  23.      These routines are part of the SCSL Scientific Library and can be loaded
  24.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  25.      directs the linker to use the multi-processor version of the library.
  26.  
  27.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  28.      4 bytes (32 bits). Another version of SCSL is available in which integers
  29.      are 8 bytes (64 bits).  This version allows the user access to larger
  30.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  31.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  32.      only one of the two versions; 4-byte integer and 8-byte integer library
  33.      calls cannot be mixed.
  34.  
  35. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  36.      SGBEQU computes row and column scalings intended to equilibrate an M-by-N
  37.      band matrix A and reduce its condition number. R returns the row scale
  38.      factors and C the column scale factors, chosen to try to make the largest
  39.      element in each row and column of the matrix B with elements
  40.      B(i,j)=R(i)*A(i,j)*C(j) have absolute value 1.
  41.  
  42.      R(i) and C(j) are restricted to be between SMLNUM = smallest safe number
  43.      and BIGNUM = largest safe number.  Use of these scaling factors is not
  44.      guaranteed to reduce the condition number of A but works well in
  45.      practice.
  46.  
  47.  
  48. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  49.      M       (input) INTEGER
  50.              The number of rows of the matrix A.  M >= 0.
  51.  
  52.      N       (input) INTEGER
  53.              The number of columns of the matrix A.  N >= 0.
  54.  
  55.      KL      (input) INTEGER
  56.              The number of subdiagonals within the band of A.  KL >= 0.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGBBBBEEEEQQQQUUUU((((3333SSSS))))                                                          SSSSGGGGBBBBEEEEQQQQUUUU((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      KU      (input) INTEGER
  75.              The number of superdiagonals within the band of A.  KU >= 0.
  76.  
  77.      AB      (input) REAL array, dimension (LDAB,N)
  78.              The band matrix A, stored in rows 1 to KL+KU+1.  The j-th column
  79.              of A is stored in the j-th column of the array AB as follows:
  80.              AB(ku+1+i-j,j) = A(i,j) for max(1,j-ku)<=i<=min(m,j+kl).
  81.  
  82.      LDAB    (input) INTEGER
  83.              The leading dimension of the array AB.  LDAB >= KL+KU+1.
  84.  
  85.      R       (output) REAL array, dimension (M)
  86.              If INFO = 0, or INFO > M, R contains the row scale factors for A.
  87.  
  88.      C       (output) REAL array, dimension (N)
  89.              If INFO = 0, C contains the column scale factors for A.
  90.  
  91.      ROWCND  (output) REAL
  92.              If INFO = 0 or INFO > M, ROWCND contains the ratio of the
  93.              smallest R(i) to the largest R(i).  If ROWCND >= 0.1 and AMAX is
  94.              neither too large nor too small, it is not worth scaling by R.
  95.  
  96.      COLCND  (output) REAL
  97.              If INFO = 0, COLCND contains the ratio of the smallest C(i) to
  98.              the largest C(i).  If COLCND >= 0.1, it is not worth scaling by
  99.              C.
  100.  
  101.      AMAX    (output) REAL
  102.              Absolute value of largest matrix element.  If AMAX is very close
  103.              to overflow or very close to underflow, the matrix should be
  104.              scaled.
  105.  
  106.      INFO    (output) INTEGER
  107.              = 0:  successful exit
  108.              < 0:  if INFO = -i, the i-th argument had an illegal value
  109.              > 0:  if INFO = i, and i is
  110.              <= M:  the i-th row of A is exactly zero
  111.              >  M:  the (i-M)-th column of A is exactly zero
  112.  
  113. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  114.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  115.  
  116.      This man page is available only online.
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.